SpringBoot应用整合ELK实现日志收集

ELK即Elasticsearch、Logstash、Kibana,组合起来可以搭建线上日志系统，本文主要讲解使用ELK来收集SpringBoot应用产生的日志。

学习前需要了解的内容

ELK中各个服务的作用

• Elasticsearch:用于存储收集到的日志信息；

• Logstash:用于收集日志，SpringBoot应用整合了Logstash以后会把日志发送给Logstash,Logstash再把日志转发给Elasticsearch；

• Kibana:通过Web端的可视化界面来查看日志。

使用Docker Compose 搭建ELK环境

需要下载的Docker镜像

1. docker pull elasticsearch:6.4.0

2. docker pull logstash:6.4.0

3. docker pull kibana:6.4.0

搭建前准备

• elasticsearch 启动成功需要特殊配置，具体参考mall在Linux环境下的部署（基于Docker Compose）中的elasticsearch部分；

• docker-compose.yml文件地址:https://github.com/macrozheng/mall-learning/blob/master/mall-tiny-elk/src/main/docker/docker-compose.yml

• logstash-springboot.conf配置文件地址：https://github.com/macrozheng/mall-learning/blob/master/mall-tiny-elk/src/main/docker/logstash-springboot.conf

开始搭建

创建一个存放logstash配置的目录并上传配置文件

logstash-springboot.conf文件内容

1. input {

2. tcp {

3. mode => "server"

4. host => "0.0.0.0"

5. port => 4560

6. codec => json_lines

7. }

8. }

9. output {

10. elasticsearch {

11. hosts => "es:9200"

12. index => "springboot-logstash-%{+YYYY.MM.dd}"

13. }

14. }

创建配置文件存放目录并上传配置文件到该目录

1. mkdir /mydata/logstash

使用docker-compose.yml脚本启动ELK服务

docker-compose.yml内容

1. version: '3'

2. services:

3. elasticsearch:

4. image: elasticsearch:6.4.0

5. container_name: elasticsearch

6. environment:

7. - "cluster.name=elasticsearch" #设置集群名称为elasticsearch

8. - "discovery.type=single-node" #以单一节点模式启动

9. - "ES_JAVA_OPTS=-Xms512m -Xmx512m" #设置使用jvm内存大小

10. volumes:

11. - /mydata/elasticsearch/plugins:/usr/share/elasticsearch/plugins #插件文件挂载

12. - /mydata/elasticsearch/data:/usr/share/elasticsearch/data #数据文件挂载

13. ports:

14. - 9200:9200

15. kibana:

16. image: kibana:6.4.0

17. container_name: kibana

18. links:

19. - elasticsearch:es #可以用es这个域名访问elasticsearch服务

20. depends_on:

21. - elasticsearch #kibana在elasticsearch启动之后再启动

22. environment:

23. - "elasticsearch.hosts=http://es:9200" #设置访问elasticsearch的地址

24. ports:

25. - 5601:5601

26. logstash:

27. image: logstash:6.4.0

28. container_name: logstash

29. volumes:

30. - /mydata/logstash/logstash-springboot.conf:/usr/share/logstash/pipeline/logstash.conf #挂载logstash的配置文件

31. depends_on:

32. - elasticsearch #kibana在elasticsearch启动之后再启动

33. links:

34. - elasticsearch:es #可以用es这个域名访问elasticsearch服务

35. ports:

36. - 4560:4560

上传到linux服务器并使用docker-compose命令运行

1. docker-compose up -d

注意：Elasticsearch启动可能需要好几分钟，要耐心等待。

在logstash中安装json_lines插件

1. # 进入logstash容器

2. docker exec -it logstash /bin/bash

3. # 进入bin目录

4. cd /bin/

5. # 安装插件

6. logstash-plugin install logstash-codec-json_lines

7. # 退出容器

8. exit

9. # 重启logstash服务

10. docker restart logstash

开启防火墙并在kibana中查看

1. systemctl stop firewalld

访问地址：http://192.168.3.101:5601

SpringBoot应用集成Logstash

在pom.xml中添加logstash-logback-encoder依赖

1. <!--集成logstash-->

2. <dependency>

3. <groupId>net.logstash.logback</groupId>

4. <artifactId>logstash-logback-encoder</artifactId>

5. <version>5.3</version>

6. </dependency>

添加配置文件logback-spring.xml让logback的日志输出到logstash

注意appender节点下的destination需要改成你自己的logstash服务地址，比如我的是：192.168.3.101:4560 。

1. <?xml version="1.0" encoding="UTF-8"?>

2. <!DOCTYPE configuration>

3. <configuration>

4. <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

5. <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>

6. <!--应用名称-->

7. <property name="APP_NAME" value="mall-admin"/>

8. <!--日志文件保存路径-->

9. <property name="LOG_FILE_PATH" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/logs}"/>

10. <contextName>${APP_NAME}</contextName>

11. <!--每天记录日志到文件appender-->

12. <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

13. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

14. <fileNamePattern>${LOG_FILE_PATH}/${APP_NAME}-%d{yyyy-MM-dd}.log</fileNamePattern>

15. <maxHistory>30</maxHistory>

16. </rollingPolicy>

17. <encoder>

18. <pattern>${FILE_LOG_PATTERN}</pattern>

19. </encoder>

20. </appender>

21. <!--输出到logstash的appender-->

22. <appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">

23. <!--可以访问的logstash日志收集端口-->

24. <destination>192.168.3.101:4560</destination>

25. <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder"/>

26. </appender>

27. <root level="INFO">

28. <appender-ref ref="CONSOLE"/>

29. <appender-ref ref="FILE"/>

30. <appender-ref ref="LOGSTASH"/>

31. </root>

32. </configuration>

运行Springboot应用

在kibana中查看日志信息

创建index pattern

查看收集的日志

调用接口进行测试

制造一个异常并查看

修改获取所有品牌列表接口

调用该接口并查看日志

总结

搭建了ELK日志收集系统之后，我们如果要查看SpringBoot应用的日志信息，就不需要查看日志文件了，直接在Kibana中查看即可。

项目源码地址

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-elk

推荐阅读

---

欢迎关注，点个在看